Added new AVP::AnimationOptimization property #6269

aborziak-ms · 2021-11-10T00:32:53Z

Description

In this change we are adding AnimationOptimization property to the AnimatedVisualPlayer. This property has two possible values: Resources or Latency (default).
When animation is completed and optimization mode is set to Resources we will destroy all the windows composition animations from the lottie side. When we call PlayAsync or SetProgress we will re-instantiate all the animations again.
If optimization mode is set to Latency we will immediately instantiate all the animations and will keep them even if AVP is not playing anything.

Also in order to expose this functionality from LottieGen side we need to add IAnimatedVisual and IAnimatedVisualSource3 interfaces that are used only by AVP.

Motivation and Context

There are some performance issues with the current implementation of LottieGen and AnimatedVisual Player:

Complex Lottie animations can instantiate a lot of composition animations which may impact performance and overall battery life.
Lottie files that have a lot of complex animations even when they are paused, have some cost to performance.
The Idle (paused) lottie animations use the same amount of CPU resources as when they are playing the actual animation.

#6268

raymond-wh-leung · 2021-11-10T01:04:31Z

dev/AnimatedVisualPlayer/AnimatedVisualPlayer.cpp

    auto clampedProgress = std::clamp(static_cast<float>(progress), 0.0F, 1.0F);

    // WARNING: Reentrance via IsPlaying DP may occur from this point down to the end of the method
    //          iff m_nowPlaying.

    // Setting the Progress value will stop the current play.
    m_progressPropertySet.InsertScalar(L"Progress", static_cast<float>(clampedProgress));
+    m_lastPlayProgress = progress;


m_lastPlayProgress = progress

m_lastPlayProgress will be clamped later when it is used? (i.e. in stop?)

ah, probably it is better to set it to clampedProgress here, thx

raymond-wh-leung

ranjeshj · 2021-11-10T14:46:32Z

/azp run

azure-pipelines · 2021-11-10T14:46:44Z

Azure Pipelines successfully started running 1 pipeline(s).

ranjeshj · 2021-11-10T18:30:57Z

dev/AnimatedVisualPlayer/AnimatedVisualPlayer.idl

@@ -62,6 +88,9 @@ unsealed runtimeclass AnimatedVisualPlayer
    [MUX_DEFAULT_VALUE("true")]
    [MUX_PROPERTY_CHANGED_CALLBACK(TRUE)]
    Boolean AutoPlay;
+    [MUX_DEFAULT_VALUE("winrt::AnimationsCacheModeEnum::Always")]


You would need to version these APIs since you are adding to an existing type. See MUX_PUBLIC_V2 to see how it is done in other types. @kmahone as FYI

…IAnimatedVisualSource3 method

…layer2 because it was not doing so due to the DeriveFromPanelHelper_base implementation.

StephenLPeters · 2022-01-20T04:37:24Z

/azp run

azure-pipelines · 2022-01-20T04:37:34Z

Azure Pipelines successfully started running 1 pipeline(s).

jevansaks · 2022-01-20T17:31:04Z

dev/AnimatedVisualPlayer/AnimatedVisualPlayer.cpp

+                    if (m_owner) 
+                    {                        
+                        // If optimization is set to Resources - destroy animations immediately after player stops.
+                        if (m_owner->AnimatedVisualPlayerProperties::AnimationOptimization() == winrt::PlayerAnimationOptimization::Resources)


AnimatedVisualPlayerProperties::AnimationOptimization

Being explicit in this way is non-intuitive. The other cases where this ambiguity has come up we've put this in the class in the header file:

using AnimatedVisualPlayerProperties::AnimationOptimization;

…into user/aborziak/new-avp-api

StephenLPeters · 2022-01-24T22:07:12Z

/azp run

azure-pipelines · 2022-01-24T22:07:24Z

Azure Pipelines successfully started running 1 pipeline(s).

StephenLPeters · 2022-01-25T02:54:16Z

/azp run

azure-pipelines · 2022-01-25T02:54:27Z

Azure Pipelines successfully started running 1 pipeline(s).

StephenLPeters · 2022-01-25T19:51:16Z

dev/AnimatedVisualPlayer/AnimatedVisualPlayer.cpp

+    }
+
+    // Call RequestCommit to make sure that previous compositor calls complete before destroying animations.
+    m_rootVisual.Compositor().RequestCommitAsync().Completed(


RequestCommitAsync() is only available on Rs4+ we need to gracefully handle the case where this API isn't available on RS2 and RS3.

dev/AnimatedVisualPlayer/AnimatedVisualPlayer.cpp

StephenLPeters · 2022-01-25T20:45:19Z

dev/AnimatedVisualPlayer/AnimatedVisualPlayer.cpp

    {
        return;
    }

    // Call RequestCommit to make sure that previous compositor calls complete before destroying animations.
+    // RequestCommitAsync is available only for RS4+ but m_animatedVisual is not null guarantees that we are at least RS5+


How is this the case? Don't the visuals get created at startup? and then I could call destroy animations on this and hit this code path?

Destroy and Create are private inside AVP, we are exposing only AnimationOptimization property

StephenLPeters · 2022-01-25T20:59:44Z

/azp run

azure-pipelines · 2022-01-25T20:59:55Z

Azure Pipelines successfully started running 1 pipeline(s).

Added new AVP::AnimationCacheMode API

19ba938

ghost added the needs-triage Issue needs to be triaged by the area owners label Nov 10, 2021

raymond-wh-leung reviewed Nov 10, 2021

View reviewed changes

raymond-wh-leung approved these changes Nov 10, 2021

View reviewed changes

ranjeshj requested a review from MikeHillberg November 10, 2021 14:46

ranjeshj added team-CompInput Issue for IXP (Composition, Input) team area-AnimatedVisualPlayer labels Nov 10, 2021

ranjeshj reviewed Nov 10, 2021

View reviewed changes

ranjeshj requested a review from StephenLPeters November 10, 2021 18:31

aborziak-ms added 3 commits November 10, 2021 13:45

Fixed build break and added MUX_PUBLIC_V2

5092403

Renamed InstantiateAnimations to CreateAnimations, reordered args in …

6c3d3d8

…IAnimatedVisualSource3 method

Addressed comments after discussion

46afdcd

StephenLPeters approved these changes Jan 18, 2022

View reviewed changes

aborziak-ms and others added 2 commits January 18, 2022 14:12

Stop DestroyAnimations callback after CreateAnimations is called

4edad8e

Upate animated visual player to speicially implement IAnimatedVisualP…

5bcd360

…layer2 because it was not doing so due to the DeriveFromPanelHelper_base implementation.

StephenLPeters requested review from jevansaks and Scottj1s January 20, 2022 04:37

jevansaks reviewed Jan 20, 2022

View reviewed changes

aborziak-ms changed the title ~~Added new AVP::AnimationCacheMode API~~ Added new AVP::AnimationOptimization property Jan 20, 2022

StephenLPeters added 2 commits January 24, 2022 13:46

Merge branch 'main' of https://github.com/microsoft/microsoft-ui-xaml …

9186ad7

…into user/aborziak/new-avp-api

Use a using statement instead of explicit redirection.

2379dd7

Regenerated LottieLogo file

2e7b4c8

StephenLPeters reviewed Jan 25, 2022

View reviewed changes

Added Rs5+ check

601d778

StephenLPeters reviewed Jan 25, 2022

View reviewed changes

dev/AnimatedVisualPlayer/AnimatedVisualPlayer.cpp Outdated Show resolved Hide resolved

Removed comment

977005a

StephenLPeters reviewed Jan 25, 2022

View reviewed changes

Added another rs5+ check

36f65b7

StephenLPeters merged commit 8d59449 into microsoft:main Jan 25, 2022

aborziak-ms mentioned this pull request Mar 22, 2022

Fixing null dereferencing bug #6866

Merged

krschau removed the needs-triage Issue needs to be triaged by the area owners label Jun 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added new AVP::AnimationOptimization property #6269

Added new AVP::AnimationOptimization property #6269

aborziak-ms commented Nov 10, 2021 •

edited

Loading

raymond-wh-leung Nov 10, 2021

aborziak-ms Nov 10, 2021

raymond-wh-leung left a comment

ranjeshj commented Nov 10, 2021

azure-pipelines bot commented Nov 10, 2021

ranjeshj Nov 10, 2021

aborziak-ms Nov 10, 2021

StephenLPeters commented Jan 20, 2022

azure-pipelines bot commented Jan 20, 2022

jevansaks Jan 20, 2022

StephenLPeters commented Jan 24, 2022

azure-pipelines bot commented Jan 24, 2022

StephenLPeters commented Jan 25, 2022

azure-pipelines bot commented Jan 25, 2022

StephenLPeters Jan 25, 2022

StephenLPeters Jan 25, 2022

aborziak-ms Jan 25, 2022

StephenLPeters commented Jan 25, 2022

azure-pipelines bot commented Jan 25, 2022

Added new AVP::AnimationOptimization property #6269

Added new AVP::AnimationOptimization property #6269

Conversation

aborziak-ms commented Nov 10, 2021 • edited Loading

Description

Motivation and Context

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raymond-wh-leung left a comment

Choose a reason for hiding this comment

ranjeshj commented Nov 10, 2021

azure-pipelines bot commented Nov 10, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenLPeters commented Jan 20, 2022

azure-pipelines bot commented Jan 20, 2022

Choose a reason for hiding this comment

StephenLPeters commented Jan 24, 2022

azure-pipelines bot commented Jan 24, 2022

StephenLPeters commented Jan 25, 2022

azure-pipelines bot commented Jan 25, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenLPeters commented Jan 25, 2022

azure-pipelines bot commented Jan 25, 2022

aborziak-ms commented Nov 10, 2021 •

edited

Loading